Added docs for Grafana, editing a cluster, the API tab in an instance/cluster, etc. #386
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
heskew
reviewed
Nov 7, 2025
kriszyp
reviewed
Nov 7, 2025
…tion header to Connect to Harper
BboyAkers
force-pushed
the
fabric-docs-updates
branch
from
cdad6f2 to
acbf287
Compare
cb1kenobi
reviewed
Nov 11, 2025
cb1kenobi
reviewed
Nov 11, 2025
BboyAkers
force-pushed
the
fabric-docs-updates
branch
from
8548cbf to
4cd56e8
Compare
|
|
||
| ## Accessing the API Documentation | ||
|
|
||
| To access the API documentation, navigate to the following URL in your web browser: |
Contributor
There was a problem hiding this comment.
Suggested change
| To access the API documentation, navigate to the following URL in your web browser: | |
| To access the API documentation, navigate to the `APIs` tab in a specific Cluster. |
| To authorize API requests, you need to include a valid basic authentication header or bearer authentication token. | ||
|
|
||
| 1. Click on the "Authorize" button in the Swagger Documentation UI. | ||
| 2. Choose your preferred authentication method (Basic or Bearer) and enter your credentials or token. |
Contributor
There was a problem hiding this comment.
Can you include a note where a user may get these credentials or tokens from? Like is this something they created when they instantiated the cluster? Maybe relate or link it back to another part of the docs when they created the details to jog their memory.
fabric/grafana-integration.md
Outdated
|
|
||
| # Setup Grafana Integration with Harper | ||
|
|
||
| Grafana is an observability platform for monitoring and visualizing metrics, logs, and traces. Harper provides a plug-in to integrate with Grafana for enhanced analytics and visualization capabilities. |
Contributor
There was a problem hiding this comment.
Suggested change
| Grafana is an observability platform for monitoring and visualizing metrics, logs, and traces. Harper provides a plug-in to integrate with Grafana for enhanced analytics and visualization capabilities. | |
| Grafana is an observability platform for monitoring and visualizing metrics, logs, and traces. Harper provides a plugin to integrate with Grafana for enhanced analytics and visualization capabilities. |
|
|
||
| Grafana is an observability platform for monitoring and visualizing metrics, logs, and traces. Harper provides a plug-in to integrate with Grafana for enhanced analytics and visualization capabilities. | ||
|
|
||
| To install the Harper Grafana integration: |
Contributor
There was a problem hiding this comment.
Suggested change
| To install the Harper Grafana integration: | |
| To install the Harper Grafana plugin: |
|
|
||
| To install the Harper Grafana integration: | ||
|
|
||
| 1. Navigate to Harper's plug-in inside the [Grafana marketplace](https://grafana.com/grafana/plugins/harperfast-harper-datasource/). |
Contributor
There was a problem hiding this comment.
Suggested change
| 1. Navigate to Harper's plug-in inside the [Grafana marketplace](https://grafana.com/grafana/plugins/harperfast-harper-datasource/). | |
| 1. Navigate to the official Grafana marketplace [Harper plugin](https://grafana.com/grafana/plugins/harperfast-harper-datasource/). |
Contributor
|
My timing today is horrible; 0/2 on PR reviews before they get merged 🤦♂️ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Added docs for:
Additional Info
The "New Application" page I documented here in an earlier PR. Is this sufficient or do we want more documentation for this page?
https://docs.harperdb.io/fabric/managing-applications